<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="../css/docs.css" type="text/css" rel="stylesheet" />
<link href="../css/prettify.css" type="text/css" rel="stylesheet" />
<script src="../js/prettify.js" type="text/javascript"></script>
</head>
<body onLoad="prettyPrint()">
<div class="g-unit" id="doc-content">
<div id="api-info-block">
<div class="api-level">H3C CAS云管理平台</div>
</div>
<div id="jd-header">
<h1>按条件查询所有符合条件的虚拟机</h1>
</div>
<div id="jd-content">
<div class="jd-descr">
<p>根据条件查询所有符合条件的虚拟机。</p>
<h2><a name="uri"></a>接口 URI</h2>
<p>/cas/casrs/vm/vmList</p>
<h2><a name="access"></a>访问方法</h2>
<dl>
  <dt><b>HTTP 方法</b></dt>
  <dd>GET</dd>
  <dt><b>参数</b></dt>
  <table id="pubmethods" class="jd-sumtable">
    <tbody>
      <tr>
        <th colspan="2">路径参数（Path Parameter）</th>
      </tr>
      <tr>
        <td class="jd-typecol">hostId</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">主机id 。</span>
        可以按主机id查询指定主机下的虚拟机。
          <div class="jd-descrdiv">长整数（long）类型。可选。</div>        </td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol">clusterId</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">集群id 。</span>
          可以按<span class="sympad">集群</span>id查询指定<span class="sympad">集群</span>下的虚拟机。
          <div class="jd-descrdiv">长整数（long）类型。可选。</div></td></tr>
	  <tr>
        <td class="jd-typecol">hpId</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">主机池id 。</span>
          可以按<span class="sympad">主机池</span>id查询指定<span class="sympad">主机池</span>下的虚拟机。
<div class="jd-descrdiv">长整数（long）类型。可选。</div>        </td>
      </tr>
	  <tr class="alt-color">
        <td class="jd-typecol">offset</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">返回的第一条记录在总结果集中的位置</span>。
          <div class="jd-descrdiv">整数（int）类型，非必须，缺省为 0。如果传入参数小于 0，则使用缺省值 0。</div></td>
      </tr>
      <tr>
        <td class="jd-typecol">limit</td>
        <td class="jd-linkcol" width="100%"><span class="sympad">返回记录总数。</span>
            <div class="jd-descrdiv">整数（int）类型，非必须，缺省为 10。如果传入参数小于 0，则使用缺省值 10。</div></td>
      </tr>
      <tr class="alt-color">
        <td class="jd-typecol">orderBy</td>
        <td class="jd-linkcol">排序字段。
          <div class="jd-descrdiv">字符串（String）类型，非必须。如按虚拟机名称排序，则参数值为title,按创建日期排序，则参数值为createDate。其他支持的排序字段：id description memory cpu system </div></td>
      </tr>
      
  </table>
</dl>
<h2><a name="result"></a>返回结果</h2>
<dl>
  <dt><b>状态码</b></dt>
  <dd>
  <ul>
    <li>200(OK)：成功。</li>
  </ul>
  </dd>
  <dt><b>消息头</b></dt>
  <br>
  <pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Total: 7</pre>
  <dt><b>消息体</b></dt>
  <div class="source">
    <pre class="prettyprint lang-xml">&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;<br>&lt;list&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;156&lt;/id&gt;<br>    &lt;hostId&gt;1&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;1&lt;/hostPoolId&gt;<br>    &lt;name&gt;08DC-R2-SQL08-x64&lt;/name&gt;<br>    &lt;title&gt;08DC-R2-SQL08-x64&lt;/title&gt;<br>    &lt;hostName&gt;cvk28&lt;/hostName&gt;<br>    &lt;memory&gt;4096&lt;/memory&gt;<br>    &lt;cpuRate&gt;10.261904761904763&lt;/cpuRate&gt;<br>    &lt;memRate&gt;95.72999999999973&lt;/memRate&gt;<br>    &lt;cpu&gt;12&lt;/cpu&gt;<br>    &lt;vmStatus&gt;running&lt;/vmStatus&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>  &lt;/domain&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;48&lt;/id&gt;<br>    &lt;hostId&gt;1&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;1&lt;/hostPoolId&gt;<br>    &lt;name&gt;aabb&lt;/name&gt;<br>    &lt;title&gt;aabb&lt;/title&gt;<br>    &lt;hostName&gt;cvk28&lt;/hostName&gt;<br>    &lt;memory&gt;1024&lt;/memory&gt;<br>    &lt;cpuRate&gt;0.0&lt;/cpuRate&gt;<br>    &lt;memRate&gt;0.0&lt;/memRate&gt;<br>    &lt;cpu&gt;1&lt;/cpu&gt;<br>    &lt;vmStatus&gt;shutOff&lt;/vmStatus&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>    &lt;osDesc&gt;Microsoft Windows Server 2012&lt;/osDesc&gt;<br>  &lt;/domain&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;70&lt;/id&gt;<br>    &lt;hostId&gt;1&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;1&lt;/hostPoolId&gt;<br>    &lt;name&gt;rfdsfsd&lt;/name&gt;<br>    &lt;title&gt;dsfsdfe&lt;/title&gt;<br>    &lt;hostName&gt;cvk28&lt;/hostName&gt;<br>    &lt;memory&gt;1024&lt;/memory&gt;<br>    &lt;cpuRate&gt;0.0&lt;/cpuRate&gt;<br>    &lt;memRate&gt;0.0&lt;/memRate&gt;<br>    &lt;cpu&gt;12&lt;/cpu&gt;<br>    &lt;vmStatus&gt;shutOff&lt;/vmStatus&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>  &lt;/domain&gt;<br>&lt;/list&gt;<br></pre>
  </div>
</dl>
<dt><a name="detail"></a><b>元素含义</b></dt>
<table class="jd-sumtable" id="pubmethods">
  <tbody>
    <tr>
      <th colspan="2"><span class="prettyprint lang-xml">domain</span>各子元素</th>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">id</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol">hostId</td>
      <td class="jd-linkcol"><span class="sympad">运行的主机ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">clusterId</span></td>
      <td class="jd-linkcol"><span class="sympad">所属的集群 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">hostPoolId</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">所属的主机池 ID。</span>
          <div class="jd-descrdiv">长整数（long）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">name</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机名称。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">title</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机显示名称。</span>
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">memory</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机内存大小，</span>单位（M） <span class="sympad">。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">cpu</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机CPU个数。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr>
      <td class="jd-typecol"><span class="prettyprint lang-xml">vmStatus</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机状态。</span>
          <div class="jd-descrdiv">字符串（String）类型。<span class="sympad"> <span class="prettyprint lang-xml">running</span>：运行 <span class="prettyprint lang-xml">shutOff</span>：关闭 paused：暂停。</span></div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">cpuRate</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机CPU利用率。</span>
          <div class="jd-descrdiv">浮点数（Double）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">memRate</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机内存利用率。</span>
          <div class="jd-descrdiv">浮点数（Double）类型。</div></td>
    </tr>
    <tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">system</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机安装的操作系统类型。0：Windows 1：Linux。</span>
          <div class="jd-descrdiv">整数（int）类型。</div></td>
    </tr>
    <tr >
      <td class="jd-typecol"><span class="prettyprint lang-xml">osDesc</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机操作系统详细版本号信息。</span>
        如：
          Microsoft Windows Server 2012
          <div class="jd-descrdiv">字符串（String）类型。</div></td>
    </tr>
	<tr class="alt-color">
      <td class="jd-typecol"><span class="prettyprint lang-xml">hostName</span></td>
      <td class="jd-linkcol" width="100%"><span class="sympad">虚拟机属主主机名称。</span>
        <div class="jd-descrdiv">字符串（String）类型。</div></td></tr>
</table>
<p>&nbsp;</p>
<h2><a name="example"></a>应用举例</h2>
    <p>1.查询主机id为21下的所有虚拟机信息。</p>
    <dl>
      <dt><b>请求</b></dt>
      <div class="source">
        <pre class="prettyprint lang-xml">GET http://localhost:8080/cas/casrs/vm/vmList?offset=0&amp;limit=10&amp;sortField=title&amp;clusterId=1
accept: application/xml
...
        </pre>
      </div>
      <dt><b>回应</b></dt>
      <div class="source"><pre class="prettyprint lang-xml">
HTTP/1.1 200 OK
Content-Type: application/xml
...<br>&lt;list&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;156&lt;/id&gt;<br>    &lt;hostId&gt;1&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;1&lt;/hostPoolId&gt;<br>    &lt;name&gt;08DC-R2-SQL08-x64&lt;/name&gt;<br>    &lt;title&gt;08DC-R2-SQL08-x64&lt;/title&gt;<br>    &lt;hostName&gt;cvk28&lt;/hostName&gt;<br>    &lt;memory&gt;4096&lt;/memory&gt;<br>    &lt;cpuRate&gt;10.261904761904763&lt;/cpuRate&gt;<br>    &lt;memRate&gt;95.72999999999973&lt;/memRate&gt;<br>    &lt;cpu&gt;12&lt;/cpu&gt;<br>    &lt;vmStatus&gt;running&lt;/vmStatus&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>  &lt;/domain&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;48&lt;/id&gt;<br>    &lt;hostId&gt;1&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;1&lt;/hostPoolId&gt;<br>    &lt;name&gt;aabb&lt;/name&gt;<br>    &lt;title&gt;aabb&lt;/title&gt;<br>    &lt;hostName&gt;cvk28&lt;/hostName&gt;<br>    &lt;memory&gt;1024&lt;/memory&gt;<br>    &lt;cpuRate&gt;0.0&lt;/cpuRate&gt;<br>    &lt;memRate&gt;0.0&lt;/memRate&gt;<br>    &lt;cpu&gt;1&lt;/cpu&gt;<br>    &lt;vmStatus&gt;shutOff&lt;/vmStatus&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>    &lt;osDesc&gt;Microsoft Windows Server 2012&lt;/osDesc&gt;<br>  &lt;/domain&gt;<br>  &lt;domain&gt;<br>    &lt;id&gt;70&lt;/id&gt;<br>    &lt;hostId&gt;1&lt;/hostId&gt;<br>    &lt;clusterId&gt;1&lt;/clusterId&gt;<br>    &lt;hostPoolId&gt;1&lt;/hostPoolId&gt;<br>    &lt;name&gt;rfdsfsd&lt;/name&gt;<br>    &lt;title&gt;dsfsdfe&lt;/title&gt;<br>    &lt;hostName&gt;cvk28&lt;/hostName&gt;<br>    &lt;memory&gt;1024&lt;/memory&gt;<br>    &lt;cpuRate&gt;0.0&lt;/cpuRate&gt;<br>    &lt;memRate&gt;0.0&lt;/memRate&gt;<br>    &lt;cpu&gt;12&lt;/cpu&gt;<br>    &lt;vmStatus&gt;shutOff&lt;/vmStatus&gt;<br>    &lt;system&gt;0&lt;/system&gt;<br>  &lt;/domain&gt;<br>&lt;/list&gt;<br><br></pre>
      </div>
    </dl>
</div>
</div>
</div>
</body>
</html>